Fix API deleteTrafficType not filtering physical network by GutoVeronezi · Pull Request #6510 · apache/cloudstack

GutoVeronezi · 2022-06-27T13:51:03Z

Description

While deleting a traffic type, ACS validates if there is any VM related to it. However, if we have several physical networks containing a traffic type, ACS does not filter the physical network to do the validation. For instance, if we have two (2) physical networks containing the traffic type Guest, the first one having VMs related, and the second not having VMs related, if we try to remove the second traffic type, ACS give us the message The Traffic Type is not deletable because there are existing networks with this traffic type:Guest.

The API deleteTrafficType was designed to filter the physical network where the traffic type is, however, due to a typo this filtering was not been applied correctly. This PR intends to fix this typo to honor the API behavior.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)

Feature/Enhancement Scale or Bug Severity

Bug Severity

How Has This Been Tested?

In an advanced zone I created 4 physical networks, one for each traffic type (Public, Guest, Management, Storage). I instantiated some VMs so they get guest IPs. In the Public physical network I added a Guest traffic type. I tried to remove the new Guest traffic type from Public physical network, which did not have any VMs related to it, and, before the changes, I was getting the message The Traffic Type is not deletable because there are existing networks with this traffic type:Guest. After the changes, I could remove successfully the new Guest traffic type via API deleteTrafficType. I also tried to remove the Guest traffic type which had VMs related to it, however, as expected, I received the The Traffic Type is not deletable... message.

I also created a unit test to validate the data retrieving.

sonarqubecloud · 2022-06-27T19:14:46Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

100.0% Coverage
0.0% Duplication

DaanHoogland · 2022-06-28T07:31:19Z

        final SearchCriteria<NetworkVO> sc = AllFieldsSearch.create();
        sc.setParameters("trafficType", trafficType);
-        sc.setParameters("physicalNetworkId", physicalNetworkId);
+        sc.setParameters("physicalNetwork", physicalNetworkId);


this is strange, the field in both NetworkVO and in PhysicalNetworkTrafficType is called physicalNetworkId. I would say the new value is the typo. Do you know why this should work this way @GutoVeronezi ?

@DaanHoogland, SearchCriteria works according the declaration of the field while creating the SearchBuilder. The field representing the physical network ID was declared as physicalNetwork:

cloudstack/engine/schema/src/main/java/com/cloud/network/dao/NetworkDaoImpl.java

Lines 122 to 141 in ea9124e

AllFieldsSearch = createSearchBuilder();

AllFieldsSearch.and("name", AllFieldsSearch.entity().getName(), Op.EQ);

AllFieldsSearch.and("trafficType", AllFieldsSearch.entity().getTrafficType(), Op.EQ);

AllFieldsSearch.and("cidr", AllFieldsSearch.entity().getCidr(), Op.EQ);

AllFieldsSearch.and("broadcastType", AllFieldsSearch.entity().getBroadcastDomainType(), Op.EQ);

AllFieldsSearch.and("offering", AllFieldsSearch.entity().getNetworkOfferingId(), Op.EQ);

AllFieldsSearch.and("datacenter", AllFieldsSearch.entity().getDataCenterId(), Op.EQ);

AllFieldsSearch.and("account", AllFieldsSearch.entity().getAccountId(), Op.EQ);

AllFieldsSearch.and("related", AllFieldsSearch.entity().getRelated(), Op.EQ);

AllFieldsSearch.and("guestType", AllFieldsSearch.entity().getGuestType(), Op.EQ);

AllFieldsSearch.and("physicalNetwork", AllFieldsSearch.entity().getPhysicalNetworkId(), Op.EQ);

AllFieldsSearch.and("broadcastUri", AllFieldsSearch.entity().getBroadcastUri(), Op.EQ);

AllFieldsSearch.and("vpcId", AllFieldsSearch.entity().getVpcId(), Op.EQ);

AllFieldsSearch.and("aclId", AllFieldsSearch.entity().getNetworkACLId(), Op.EQ);

AllFieldsSearch.and("redundant", AllFieldsSearch.entity().isRedundant(), Op.EQ);

final SearchBuilder<NetworkOfferingVO> join1 = _ntwkOffDao.createSearchBuilder();

join1.and("isSystem", join1.entity().isSystemOnly(), Op.EQ);

join1.and("isRedundant", join1.entity().isRedundantRouter(), Op.EQ);

AllFieldsSearch.join("offerings", join1, AllFieldsSearch.entity().getNetworkOfferingId(), join1.entity().getId(), JoinBuilder.JoinType.INNER);

AllFieldsSearch.done();

Therefore, we need to use physicalNetwork in the SearchCriteria in order to add the validation to the where clause.

yes, you are right, very confusing, but I shouldn´t rely on naming conventions ;)

sureshanaparti

code LGTM

sureshanaparti · 2022-06-29T04:49:09Z

@blueorangutan package

blueorangutan · 2022-06-29T04:50:03Z

@sureshanaparti a Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2022-06-29T06:37:39Z

Packaging result: ✖️ el7 ✔️ el8 ✔️ debian ✖️ suse15. SL-JID 3670

sureshanaparti · 2022-06-29T06:40:54Z

@blueorangutan package

blueorangutan · 2022-06-29T06:42:03Z

@sureshanaparti a Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2022-06-29T08:30:36Z

Packaging result: ✔️ el7 ✔️ el8 ✔️ debian ✔️ suse15. SL-JID 3673

sureshanaparti · 2022-06-29T09:28:15Z

@blueorangutan test

blueorangutan · 2022-06-29T09:29:03Z

@sureshanaparti a Trillian-Jenkins test job (centos7 mgmt + kvm-centos7) has been kicked to run smoke tests

blueorangutan · 2022-06-29T20:02:15Z

Trillian test result (tid-4402)
Environment: kvm-centos7 (x2), Advanced Networking with Mgmt server 7
Total time taken: 36615 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr6510-t4402-kvm-centos7.zip
Smoke tests completed. 98 look OK, 0 have errors
Only failed tests results shown below:

Test	Result	Time (s)	Test File

GutoVeronezi added 2 commits June 27, 2022 10:19

Fix deleteTrafficType not filtering physical network

a0632d9

Add unit test

b03cab3

boring-cyborg Bot added the component:networking label Jun 27, 2022

DaanHoogland reviewed Jun 27, 2022

View reviewed changes

Comment thread engine/schema/src/test/java/com/cloud/network/dao/NetworkDaoImplTest.java

Add license

97fcde4

DaanHoogland reviewed Jun 28, 2022

View reviewed changes

DaanHoogland approved these changes Jun 28, 2022

View reviewed changes

sureshanaparti approved these changes Jun 29, 2022

View reviewed changes

yadvr approved these changes Jul 1, 2022

View reviewed changes

yadvr merged commit 7d932e5 into apache:main Jul 1, 2022

yadvr added this to the 4.18.0.0 milestone Jul 1, 2022

yadvr added the component:api label Jul 1, 2022

GutoVeronezi mentioned this pull request Dec 4, 2025

Fix API deleteTrafficType not filtering physical network II #12184

Merged

10 tasks

	AllFieldsSearch = createSearchBuilder();
	AllFieldsSearch.and("name", AllFieldsSearch.entity().getName(), Op.EQ);
	AllFieldsSearch.and("trafficType", AllFieldsSearch.entity().getTrafficType(), Op.EQ);
	AllFieldsSearch.and("cidr", AllFieldsSearch.entity().getCidr(), Op.EQ);
	AllFieldsSearch.and("broadcastType", AllFieldsSearch.entity().getBroadcastDomainType(), Op.EQ);
	AllFieldsSearch.and("offering", AllFieldsSearch.entity().getNetworkOfferingId(), Op.EQ);
	AllFieldsSearch.and("datacenter", AllFieldsSearch.entity().getDataCenterId(), Op.EQ);
	AllFieldsSearch.and("account", AllFieldsSearch.entity().getAccountId(), Op.EQ);
	AllFieldsSearch.and("related", AllFieldsSearch.entity().getRelated(), Op.EQ);
	AllFieldsSearch.and("guestType", AllFieldsSearch.entity().getGuestType(), Op.EQ);
	AllFieldsSearch.and("physicalNetwork", AllFieldsSearch.entity().getPhysicalNetworkId(), Op.EQ);
	AllFieldsSearch.and("broadcastUri", AllFieldsSearch.entity().getBroadcastUri(), Op.EQ);
	AllFieldsSearch.and("vpcId", AllFieldsSearch.entity().getVpcId(), Op.EQ);
	AllFieldsSearch.and("aclId", AllFieldsSearch.entity().getNetworkACLId(), Op.EQ);
	AllFieldsSearch.and("redundant", AllFieldsSearch.entity().isRedundant(), Op.EQ);
	final SearchBuilder<NetworkOfferingVO> join1 = _ntwkOffDao.createSearchBuilder();
	join1.and("isSystem", join1.entity().isSystemOnly(), Op.EQ);
	join1.and("isRedundant", join1.entity().isRedundantRouter(), Op.EQ);
	AllFieldsSearch.join("offerings", join1, AllFieldsSearch.entity().getNetworkOfferingId(), join1.entity().getId(), JoinBuilder.JoinType.INNER);
	AllFieldsSearch.done();

Uh oh!

Conversation

GutoVeronezi commented Jun 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Bug Severity

How Has This Been Tested?

Uh oh!

Uh oh!

sonarqubecloud Bot commented Jun 27, 2022

Uh oh!

DaanHoogland Jun 28, 2022

Choose a reason for hiding this comment

Uh oh!

GutoVeronezi Jun 28, 2022

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jun 28, 2022

Choose a reason for hiding this comment

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

sureshanaparti commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

sureshanaparti commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

blueorangutan commented Jun 29, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

GutoVeronezi commented Jun 27, 2022 •

edited

Loading